home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 001 / modbutlr.arc / BUTLER.DOC < prev    next >
Text File  |  1986-06-18  |  9KB  |  187 lines
  1. ------------------------------------------------------------------------------
  2.       SHORT AND TEMPORARY DOCUMENTATION FOR MODEM BUTLER VERSION 2.03
  3. ------------------------------------------------------------------------------
  4.  
  5. ─Invoking ModemButler from DOS────────────────────────────────────────────────
  6.  
  7. from DOS, type:
  8. BUTLER CMNDFILE[.EXT] HISTFILE[.HIS] {str1} .. {str7}
  9.        │                 │                 └───────────┐
  10. ╔══════╧═══════════╗ ╔═══╧═════════════════╗  ╔════════╧══════════════════╗
  11. ║ the name  of the ║ ║ name of the history ║  ║ up to 7  strings (without ║
  12. ║ command file you ║ ║ file    for    this ║  ║ quotes or  spaces) can be ║
  13. ║ wish to execute. ║ ║ session. If omitted ║  ║ specified.  The 7 will be ║
  14. ║ EXT    optional, ║ ║ CMNDFILE.HIS     is ║  ║ placed  in  parameters |1 ║
  15. ║ .BUT used  if no ║ ║ used.   If  no  EXT ║  ║ thru  |7.  These  strings ║
  16. ║ EXT supplied.    ║ ║ specified,     .HIS ║  ║ are optional.             ║
  17. ╚═Command Filename═╝ ║ used.               ║  ╚══Setting Parameters═══════╝
  18.                      ╚═History Filename════╝
  19.  
  20.  
  21. ─Conventions Used in this Listing─────────────────────────────────────────────
  22.  
  23. {num}             parameter required is a number
  24. {label}           a string of characters (not including a space) "marking"
  25.                   a section of your command file.  Lower-case characters
  26.                   are different than upper-case (i.e. LABEL, label and Label
  27.                   are all different labels)
  28. {filename}        parameter required is a legal file name
  29. /                 denotes a choice of parameters for this command
  30. \
  31. {char}            one alphanumeric character (a letter, number or symbol)
  32.                     is required
  33. {HH:MM:SS}        time value in DOS standard 24 hour format.  Separate with
  34.                     colons, no spaces
  35. {str}             a string, delimited by " is required (i.e., "Hello" is
  36.                     legal, Hello is not).  The placement of a { in a string
  37.                     will cause a CR (carrage return) to be substituted in its
  38.                     place.  This means that you can't use the character {
  39.                     in a string except to signify a return
  40. {ph no}           a series of characters ( - () and modem commands are legal)
  41.                     which will be sent to the modem with the dialing command
  42. {drive/path}      a string without quotes which specifies a drive and/or path
  43.                     (i.e., B:\TURBO\BUTLER or A:)
  44.  
  45.  
  46. ─Brief Listing of Commands────────────────────────────────────────────────────
  47.  
  48. .      A period followed by anything is disregarded by BUTLER.  This is used
  49.        for the purposes of documenting your command files
  50.        NOTE: this character can be changed through the BUTINST utility
  51.  
  52. {      This symbol will be replaced with a Carriage Return (CR) value when
  53.        found in the command file.  As a consequence, this character cannot
  54.        be represented in a string unless you change to something else through
  55.        BUTINST
  56.        NOTE: this character can be changed through the BUTINST utility.
  57.  
  58. ]{label}  This is the syntax for a label declaration.  For rules regarding the
  59.           naming of labels, see "Conventions" section above.  To see what
  60.           labels are good for, see the GOTO command below.  This statement
  61.           alone will not have any visible effect upon command file execution.
  62.           NOTE: this character (]) can be changed through the BUTINST utility.
  63.  
  64. |{char}     When placed anywhere in a command file, will cause the |{char} to
  65.             be replaced with the corresponding parameter.  The parameter and
  66.             the {char}, which I'll call a trigger, can be specified in
  67.             three ways:
  68.               -  through the command line, |1 through |7 can be specified.
  69.               -  through the ASK command (see below) any string can be
  70.                  attached to any trigger (numeric or a letter) interactively
  71.               -  through the ASSIGN command (see below) any string can be
  72.                  set to any trigger in the command file.
  73.             Up to twenty trigger/parameter combinations can be specified,
  74.             using whatever trigger symbols you desire.
  75.  
  76. ASK {char} {str}    Places BUTLER in an interactive mode.  A small window is
  77.                     opened on screen, and {str} is displayed (as a prompt).
  78.                     The operator must then enter a string (quotes aren't
  79.                     needed as delimiters) which is placed in the parameter
  80.                     corresponding to (char)
  81.  
  82. ASSIGN {char} {str}  Assigns parameter {str} to trigger {char}
  83.  
  84. BAUD {num}     Change baud rate  [default 1200]
  85.  
  86. BEEP {num}     Beeps the speaker for approximately 3 seconds in the frequency
  87.                {num} Hz. (Hertz)
  88.  
  89. CHARDELAY {num}     Set the delay between characters in Ascii file transfers
  90.                     to {num}
  91.  
  92. CHDIR {drive/path}  Changes the current path/drive to the specified
  93.                     drive/path
  94.  
  95. DATABITS {num}  Change data bits  [default 8]
  96.  
  97. DIAL command:
  98. The DIAL command is based upon a nine number redial circular queue, or
  99. list.  What this basically means is that with one command you can dial
  100. up to nine systems in a row until one answers.  For example, you can say:
  101.   DIAL 333-1212 QMODEM 5 6 7
  102. This will do the following:  first, it will add the number 333-1212 to the
  103. queue.  Then ModemButler will attempt to read QMODEM.FON from the current
  104. drive/path because it finds QMODEM on the command line.  It will add Qmodem
  105. phone book entries #5, #6 and #7 to the queue.  Since there are no more
  106. numbers on the line, Butler will proceed to dial all 4 until it connects with
  107. one.  A DIAL command without any parameters will just dial whatever is left
  108. in the queue (numbers are deleted from the queue after a connection is made).
  109.  
  110. DIAL {ph no1} ... {ph no9}
  111.         and/or QMODEM {num1} ... {num9}
  112.  
  113. DOWNLOAD command:
  114. same subcommands as the UPLOAD command, except that NO {filename} should be
  115. specified for YMODEM, BATCH, TELINK or MODEM7 protocol.  The sending system
  116. specifies the sending filename as part of the transfer.  NOTE:  Please see
  117. UPLOAD command below.
  118.  
  119. ECHO / ON      Turn echo on (half duplex)
  120.      \ OFF     Turn echo off (full duplex) [default off]
  121.  
  122. GOTO {label}   This will cause ModemButler to "search" for the label character
  123.                followed by {label}.  File execution will continue from that
  124.                point.  The GOTO can be issued from before or after the label
  125.                named.  If no {label} is found, an error is issued and command
  126.                file execution is halted.
  127.                By the way, since ModemButler searches in sequential order
  128.                from the first to the last line in the command file for the
  129.                matching label, it can take longer to reach a label at the
  130.                end (as opposed to the beginning) of a command file.
  131.  
  132. HANG  Hang up the phone.
  133.  
  134. LINEDELAY {num}     Set the delay between lines in Ascii file transfers to
  135.                     {num}
  136.  
  137. NOTE {str}       Displays NOTE: followed by {str} in the message window
  138.                  on-screen
  139.  
  140. PACING {char}    Set the Pacing character in Ascii file transfers to {char}
  141.  
  142. PORT {num}     Comm port to use  [default 1]
  143.  
  144. PARITY {char}   Change parity  [default N]
  145.  
  146. PULSE / OFF     Will DIAL using tone prefix
  147.       \ ON      Will DIAL using pulse prefix  [default]
  148.  
  149.      / CHAR {str}     Send {str}
  150. SEND \ ASCII {num}    Send Ascii code {num}
  151.  
  152. Please note that if you wish to SEND a cr (carrage return) after a string,
  153. just place a { in the string (i.e., SEND "NAME{").  If you want to send just
  154. a return, you can say SEND "{".
  155.  
  156. STOPBITS {num}  Change stop bits  [default 1]
  157.  
  158. UPLOAD command:
  159.   / CRC        Set error checking to CRC
  160.     CHK        Set error checking to Checksum [default]
  161.     KERMIT     Not operational yet!
  162.     YMODEM {filename}   Upload file using Ymodem protocol
  163.     BATCH {filename} Upload file(s) matching {filename} (which can have *'s
  164.                      and ?) using the Ymodem Batch mode protocol (not
  165.                      supported everywhere).  Using BATCH, you can upload more
  166.                      than one file with one command on systems supporting it.
  167.                      Good for transfering a whole disk (*.* as {filename})
  168.                      between two BUTLER equipped computers.
  169.     TELINK {filename}   Upload file {filename} using Telink protocol
  170.   \ MODEM7 {filename}   Upload file {filename} using Modem7 protocol
  171.  
  172.      / FOR {str}     Wait until {str} received
  173. WAIT   ASCII {num}   Wait until Ascii value {num} received
  174.        TIME {HH:MM:SS}  Wait until system time is {HH:MM:SS}
  175.      \ LINES {num}   Wait until {num} lines (cr sequences) received
  176.  
  177. ──────────────────────────────────────────────────────────────────────────────
  178.  
  179. modem butler version two point zero three beta copyright 1985,86 Andrew Brenner
  180.  
  181.                 504 Glen Court
  182.                 Oceanside NY 11572
  183.                 (516) 764-5248 (voice)
  184.                 (516) 741-6914 (the railroad bbs - 300, 1200, 2400 baud)
  185.  
  186. ──────────────────────────────────────────────────────────────────────────────
  187.